<?xml version="1.0" encoding="iso-8859-1"?>
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
  <html xmlns="http://www.w3.org/1999/xhtml">
		<head>
			<!-- template designed by Marco Von Ballmoos -->
			<title>Docs For Class OAuthClient</title>
			<link rel="stylesheet" href="../media/stylesheet.css" />
			<meta http-equiv='Content-Type' content='text/html; charset=iso-8859-1'/>
		</head>
		<body>
			<div class="page-body">			
<h2 class="class-name"><img src="../media/images/Class_logo.png"
														alt=" Class"
														title=" Class"
														style="vertical-align: middle"> OAuthClient</h2>

<a name="sec-description"></a>
<div class="info-box">
	<div class="info-box-title">Description</div>
	<div class="nav-bar">
					<span class="disabled">Description</span> |
													<a href="#sec-var-summary">Vars</a> (<a href="#sec-vars">details</a>)
						|											<a href="#sec-method-summary">Methods</a> (<a href="#sec-methods">details</a>)
						
					</div>
	<div class="info-box-body">
        		<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">A simple OAuth client class for making 2 and 3 legged OAuth HTTP requests.</p>
<p class="description"><p>A simple OAuth client class for making 2 and 3 legged OAuth HTTP requests.</p></p>
		<p class="notes">
			Located in <a class="field" href="_Yahoo.inc.html">/Yahoo.inc</a> (line <span class="field"><a href="../__filesource/fsource_yos-social-php__Yahoo.inc.html#a1633">1633</a></span>)
		</p>
		
				
		<pre></pre>
	
			</div>
</div>



	<a name="sec-var-summary"></a>
	<div class="info-box">
		<div class="info-box-title">Variable Summary</span></div>
		<div class="nav-bar">
			<a href="#sec-description">Description</a> |
						<span class="disabled">Vars</span> (<a href="#sec-vars">details</a>)
							| 
									<a href="#sec-method-summary">Methods</a> (<a href="#sec-methods">details</a>)
							
								</div>
		<div class="info-box-body">
			<div class="var-summary">
																																																																<div class="var-title">
					<img src="../media/images/Variable.png" alt=" " />
					<span class="var-type">mixed</span>
					<a href="#$accepts" title="details" class="var-name">$accepts</a>
				</div>
																<div class="var-title">
					<img src="../media/images/Variable.png" alt=" " />
					<span class="var-type">mixed</span>
					<a href="#$consumer" title="details" class="var-name">$consumer</a>
				</div>
																<div class="var-title">
					<img src="../media/images/Variable.png" alt=" " />
					<span class="var-type">mixed</span>
					<a href="#$defaultTimeout" title="details" class="var-name">$defaultTimeout</a>
				</div>
																<div class="var-title">
					<img src="../media/images/Variable.png" alt=" " />
					<span class="var-type">mixed</span>
					<a href="#$oauthParamsLocation" title="details" class="var-name">$oauthParamsLocation</a>
				</div>
																<div class="var-title">
					<img src="../media/images/Variable.png" alt=" " />
					<span class="var-type">mixed</span>
					<a href="#$signatureMethod" title="details" class="var-name">$signatureMethod</a>
				</div>
																<div class="var-title">
					<img src="../media/images/Variable.png" alt=" " />
					<span class="var-type">mixed</span>
					<a href="#$token" title="details" class="var-name">$token</a>
				</div>
											</div>
		</div>
	</div>

	<a name="sec-method-summary"></a>
	<div class="info-box">
		<div class="info-box-title">Method Summary</span></div>
		<div class="nav-bar">
			<a href="#sec-description">Description</a> |
																		<a href="#sec-var-summary">Vars</a> (<a href="#sec-vars">details</a>)
				 
				|
						<span class="disabled">Methods</span> (<a href="#sec-methods">details</a>)
		</div>
		<div class="info-box-body">			
			<div class="method-summary">
																																																																								<div class="method-definition">
					<img src="../media/images/Constructor.png" alt=" "/>
											<span class="method-result">OAuthClient</span>
										<a href="#OAuthClient" title="details" class="method-name">OAuthClient</a>
											(<span class="var-type">$consumer</span>&nbsp;<span class="var-name">$consumer</span>, [<span class="var-type">$token</span>&nbsp;<span class="var-name">$token</span> = <span class="var-default">NULL</span>], [<span class="var-type">$oauthParamsLocation</span>&nbsp;<span class="var-name">$oauthParamsLocation</span> = <span class="var-default">OAUTH_PARAMS_IN_HEADERS</span>], [<span class="var-type">$signatureMethod</span>&nbsp;<span class="var-name">$signatureMethod</span> = <span class="var-default">OAUTH_SIGNATURE_HMAC_SHA1</span>])
									</div>
																<div class="method-definition">
					<img src="../media/images/Method.png" alt=" "/>
											<span class="method-result">void</span>
										<a href="#checkExpired" title="details" class="method-name">checkExpired</a>
											(<span class="var-type"></span>&nbsp;<span class="var-name">$code</span>, <span class="var-type"></span>&nbsp;<span class="var-name">$headerParser</span>)
									</div>
																<div class="method-definition">
					<img src="../media/images/Method.png" alt=" "/>
											<span class="method-result">The</span>
										<a href="#delete" title="details" class="method-name">delete</a>
											(<span class="var-type">$url</span>&nbsp;<span class="var-name">$url</span>, [<span class="var-type">$queryParameters</span>&nbsp;<span class="var-name">$queryParameters</span> = <span class="var-default">array()</span>], [<span class="var-type">$timeout</span>&nbsp;<span class="var-name">$timeout</span> = <span class="var-default">NULL</span>])
									</div>
																<div class="method-definition">
					<img src="../media/images/Method.png" alt=" "/>
											<span class="method-result">The</span>
										<a href="#get" title="details" class="method-name">get</a>
											(<span class="var-type">$url</span>&nbsp;<span class="var-name">$url</span>, [<span class="var-type">$queryParameters</span>&nbsp;<span class="var-name">$queryParameters</span> = <span class="var-default">array()</span>], [<span class="var-type">$timeout</span>&nbsp;<span class="var-name">$timeout</span> = <span class="var-default">NULL</span>])
									</div>
																<div class="method-definition">
					<img src="../media/images/Method.png" alt=" "/>
											<span class="method-result">The</span>
										<a href="#post" title="details" class="method-name">post</a>
											(<span class="var-type">$url</span>&nbsp;<span class="var-name">$url</span>, [<span class="var-type">$contentType</span>&nbsp;<span class="var-name">$contentType</span> = <span class="var-default">&quot;application/x-www-form-urlencoded&quot;</span>], [<span class="var-type">$content</span>&nbsp;<span class="var-name">$content</span> = <span class="var-default">array()</span>], [<span class="var-type">$timeout</span>&nbsp;<span class="var-name">$timeout</span> = <span class="var-default">NULL</span>])
									</div>
																<div class="method-definition">
					<img src="../media/images/Method.png" alt=" "/>
											<span class="method-result">The</span>
										<a href="#put" title="details" class="method-name">put</a>
											(<span class="var-type">$url</span>&nbsp;<span class="var-name">$url</span>, <span class="var-type">$contentType</span>&nbsp;<span class="var-name">$contentType</span>, <span class="var-type">$content</span>&nbsp;<span class="var-name">$content</span>, [<span class="var-type">$timeout</span>&nbsp;<span class="var-name">$timeout</span> = <span class="var-default">NULL</span>])
									</div>
																<div class="method-definition">
					<img src="../media/images/Method.png" alt=" "/>
											<span class="method-result">void</span>
										<a href="#request" title="details" class="method-name">request</a>
											(<span class="var-type"></span>&nbsp;<span class="var-name">$request</span>)
									</div>
											</div>
		</div>
	</div>		

	<a name="sec-vars"></a>
	<div class="info-box">
		<div class="info-box-title">Variables</div>
		<div class="nav-bar">
			<a href="#sec-description">Description</a> |
										<a href="#sec-var-summary">Vars</a> (<span class="disabled">details</span>)
						
			
										| 
									<a href="#sec-method-summary">Methods</a> (<a href="#sec-methods">details</a>)
							
					</div>
		<div class="info-box-body">
			
<a name="var$accepts" id="$accepts"><!-- --></A>
<div class="oddrow">

	<div class="var-header">
		<img src="../media/images/Variable.png" />
		<span class="var-title">
			<span class="var-type">mixed</span>
			<span class="var-name">$accepts</span>
			 = <span class="var-default"> &quot;application/json&quot;</span>			(line <span class="line-number"><a href="../__filesource/fsource_yos-social-php__Yahoo.inc.html#a1662">1662</a></span>)
		</span>
	</div>

	<!-- ========== Info from phpDoc block ========= -->
	<ul class="tags">
				<li><span class="field">private:</span> </li>
			</ul>
	
	
		
		

</div>
<a name="var$consumer" id="$consumer"><!-- --></A>
<div class="evenrow">

	<div class="var-header">
		<img src="../media/images/Variable.png" />
		<span class="var-title">
			<span class="var-type">mixed</span>
			<span class="var-name">$consumer</span>
			 = <span class="var-default"> NULL</span>			(line <span class="line-number"><a href="../__filesource/fsource_yos-social-php__Yahoo.inc.html#a1637">1637</a></span>)
		</span>
	</div>

	<!-- ========== Info from phpDoc block ========= -->
	<ul class="tags">
				<li><span class="field">private:</span> </li>
			</ul>
	
	
		
		

</div>
<a name="var$defaultTimeout" id="$defaultTimeout"><!-- --></A>
<div class="oddrow">

	<div class="var-header">
		<img src="../media/images/Variable.png" />
		<span class="var-title">
			<span class="var-type">mixed</span>
			<span class="var-name">$defaultTimeout</span>
			 = <span class="var-default"> 3</span>			(line <span class="line-number"><a href="../__filesource/fsource_yos-social-php__Yahoo.inc.html#a1647">1647</a></span>)
		</span>
	</div>

	<!-- ========== Info from phpDoc block ========= -->
	<ul class="tags">
				<li><span class="field">private:</span> </li>
			</ul>
	
	
		
		

</div>
<a name="var$oauthParamsLocation" id="$oauthParamsLocation"><!-- --></A>
<div class="evenrow">

	<div class="var-header">
		<img src="../media/images/Variable.png" />
		<span class="var-title">
			<span class="var-type">mixed</span>
			<span class="var-name">$oauthParamsLocation</span>
			 = <span class="var-default"> NULL</span>			(line <span class="line-number"><a href="../__filesource/fsource_yos-social-php__Yahoo.inc.html#a1652">1652</a></span>)
		</span>
	</div>

	<!-- ========== Info from phpDoc block ========= -->
	<ul class="tags">
				<li><span class="field">private:</span> </li>
			</ul>
	
	
		
		

</div>
<a name="var$signatureMethod" id="$signatureMethod"><!-- --></A>
<div class="oddrow">

	<div class="var-header">
		<img src="../media/images/Variable.png" />
		<span class="var-title">
			<span class="var-type">mixed</span>
			<span class="var-name">$signatureMethod</span>
			 = <span class="var-default"> NULL</span>			(line <span class="line-number"><a href="../__filesource/fsource_yos-social-php__Yahoo.inc.html#a1657">1657</a></span>)
		</span>
	</div>

	<!-- ========== Info from phpDoc block ========= -->
	<ul class="tags">
				<li><span class="field">private:</span> </li>
			</ul>
	
	
		
		

</div>
<a name="var$token" id="$token"><!-- --></A>
<div class="evenrow">

	<div class="var-header">
		<img src="../media/images/Variable.png" />
		<span class="var-title">
			<span class="var-type">mixed</span>
			<span class="var-name">$token</span>
			 = <span class="var-default"> NULL</span>			(line <span class="line-number"><a href="../__filesource/fsource_yos-social-php__Yahoo.inc.html#a1642">1642</a></span>)
		</span>
	</div>

	<!-- ========== Info from phpDoc block ========= -->
	<ul class="tags">
				<li><span class="field">private:</span> </li>
			</ul>
	
	
		
		

</div>
						
		</div>
	</div>
	
	<a name="sec-methods"></a>
	<div class="info-box">
		<div class="info-box-title">Methods</div>
		<div class="nav-bar">
			<a href="#sec-description">Description</a> |
															<a href="#sec-var-summary">Vars</a> (<a href="#sec-vars">details</a>)
														<a href="#sec-method-summary">Methods</a> (<span class="disabled">details</span>)
						
		</div>
		<div class="info-box-body">
			<A NAME='method_detail'></A>
<a name="methodOAuthClient" id="OAuthClient"><!-- --></a>
<div class="oddrow">
	
	<div class="method-header">
		<img src="../media/images/Constructor.png" />
		<span class="method-title">Constructor OAuthClient</span> (line <span class="line-number"><a href="../__filesource/fsource_yos-social-php__Yahoo.inc.html#a1672">1672</a></span>)
	</div> 
	
	<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Constructs a new OAuth client.</p>
<p class="description"><p>Constructs a new OAuth client.</p></p>
	
	<div class="method-signature">
		<span class="method-result">OAuthClient</span>
		<span class="method-name">
			OAuthClient
		</span>
					(<span class="var-type">$consumer</span>&nbsp;<span class="var-name">$consumer</span>, [<span class="var-type">$token</span>&nbsp;<span class="var-name">$token</span> = <span class="var-default">NULL</span>], [<span class="var-type">$oauthParamsLocation</span>&nbsp;<span class="var-name">$oauthParamsLocation</span> = <span class="var-default">OAUTH_PARAMS_IN_HEADERS</span>], [<span class="var-type">$signatureMethod</span>&nbsp;<span class="var-name">$signatureMethod</span> = <span class="var-default">OAUTH_SIGNATURE_HMAC_SHA1</span>])
			</div>
	
			<ul class="parameters">
					<li>
				<span class="var-type">$consumer</span>
				<span class="var-name">$consumer</span><span class="var-description">: The OAuthConsumer object to use for the requests.</span>			</li>
					<li>
				<span class="var-type">$token</span>
				<span class="var-name">$token</span><span class="var-description">: The OAuthToken to use for the requests. Optional.</span>			</li>
					<li>
				<span class="var-type">$oauthParamsLocation</span>
				<span class="var-name">$oauthParamsLocation</span><span class="var-description">: OAUTH_PARAMS_IN_HEADERS or OAUTH_PARAMS_IN_POST_BODY, depending on where you want the OAuth parameters to show up. Optional, defaults to using the headers.</span>			</li>
					<li>
				<span class="var-type">$signatureMethod</span>
				<span class="var-name">$signatureMethod</span><span class="var-description">: OAUTH_SIGNATURE_PLAINTEXT or OAUTH_SIGNATURE_HMAC_SHA1, depending on what request signing mechanism to use. Optional, defaults to HMAC SHA1 signatures.</span>			</li>
				</ul>
		
			
	</div>
<a name="methodcheckExpired" id="checkExpired"><!-- --></a>
<div class="evenrow">
	
	<div class="method-header">
		<img src="../media/images/Method.png" />
		<span class="method-title">checkExpired</span> (line <span class="line-number"><a href="../__filesource/fsource_yos-social-php__Yahoo.inc.html#a1877">1877</a></span>)
	</div> 
	
	<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Checks to see if the code and headers indicate an expired OAuth token.</p>
<p class="description"><p>Checks to see if the code and headers indicate an expired OAuth token. If so, requests a new one.</p></p>
	<ul class="tags">
				<li><span class="field">private:</span> </li>
			</ul>
	
	<div class="method-signature">
		<span class="method-result">void</span>
		<span class="method-name">
			checkExpired
		</span>
					(<span class="var-type"></span>&nbsp;<span class="var-name">$code</span>, <span class="var-type"></span>&nbsp;<span class="var-name">$headerParser</span>)
			</div>
	
			<ul class="parameters">
					<li>
				<span class="var-type"></span>
				<span class="var-name">$code</span>			</li>
					<li>
				<span class="var-type"></span>
				<span class="var-name">$headerParser</span>			</li>
				</ul>
		
			
	</div>
<a name="methoddelete" id="delete"><!-- --></a>
<div class="oddrow">
	
	<div class="method-header">
		<img src="../media/images/Method.png" />
		<span class="method-title">delete</span> (line <span class="line-number"><a href="../__filesource/fsource_yos-social-php__Yahoo.inc.html#a1717">1717</a></span>)
	</div> 
	
	<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Executes a properly signed OAuth HTTP DELETE request.</p>
<p class="description"><p>Executes a properly signed OAuth HTTP DELETE request.</p></p>
	<ul class="tags">
				<li><span class="field">return:</span> response object.</li>
			</ul>
	
	<div class="method-signature">
		<span class="method-result">The</span>
		<span class="method-name">
			delete
		</span>
					(<span class="var-type">$url</span>&nbsp;<span class="var-name">$url</span>, [<span class="var-type">$queryParameters</span>&nbsp;<span class="var-name">$queryParameters</span> = <span class="var-default">array()</span>], [<span class="var-type">$timeout</span>&nbsp;<span class="var-name">$timeout</span> = <span class="var-default">NULL</span>])
			</div>
	
			<ul class="parameters">
					<li>
				<span class="var-type">$url</span>
				<span class="var-name">$url</span><span class="var-description">: The URL to request.</span>			</li>
					<li>
				<span class="var-type">$queryParameters</span>
				<span class="var-name">$queryParameters</span><span class="var-description">: Any query string parameters to be sent in the request.</span>			</li>
					<li>
				<span class="var-type">$timeout</span>
				<span class="var-name">$timeout</span><span class="var-description">: Optional, the number of seconds to wait for the request to return.</span>			</li>
				</ul>
		
			
	</div>
<a name="methodget" id="get"><!-- --></a>
<div class="evenrow">
	
	<div class="method-header">
		<img src="../media/images/Method.png" />
		<span class="method-title">get</span> (line <span class="line-number"><a href="../__filesource/fsource_yos-social-php__Yahoo.inc.html#a1696">1696</a></span>)
	</div> 
	
	<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Executes a properly signed OAuth HTTP GET request.</p>
<p class="description"><p>Executes a properly signed OAuth HTTP GET request.</p></p>
	<ul class="tags">
				<li><span class="field">return:</span> response object.</li>
			</ul>
	
	<div class="method-signature">
		<span class="method-result">The</span>
		<span class="method-name">
			get
		</span>
					(<span class="var-type">$url</span>&nbsp;<span class="var-name">$url</span>, [<span class="var-type">$queryParameters</span>&nbsp;<span class="var-name">$queryParameters</span> = <span class="var-default">array()</span>], [<span class="var-type">$timeout</span>&nbsp;<span class="var-name">$timeout</span> = <span class="var-default">NULL</span>])
			</div>
	
			<ul class="parameters">
					<li>
				<span class="var-type">$url</span>
				<span class="var-name">$url</span><span class="var-description">: The URL to request.</span>			</li>
					<li>
				<span class="var-type">$queryParameters</span>
				<span class="var-name">$queryParameters</span><span class="var-description">: Any query string parameters to be sent in the request.</span>			</li>
					<li>
				<span class="var-type">$timeout</span>
				<span class="var-name">$timeout</span><span class="var-description">: Optional, the number of seconds to wait for the request to return.</span>			</li>
				</ul>
		
			
	</div>
<a name="methodpost" id="post"><!-- --></a>
<div class="oddrow">
	
	<div class="method-header">
		<img src="../media/images/Method.png" />
		<span class="method-title">post</span> (line <span class="line-number"><a href="../__filesource/fsource_yos-social-php__Yahoo.inc.html#a1757">1757</a></span>)
	</div> 
	
	<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Executes a properly signed OAuth HTTP POST request.</p>
<p class="description"><p>Executes a properly signed OAuth HTTP POST request.</p></p>
	<ul class="tags">
				<li><span class="field">return:</span> response object.</li>
			</ul>
	
	<div class="method-signature">
		<span class="method-result">The</span>
		<span class="method-name">
			post
		</span>
					(<span class="var-type">$url</span>&nbsp;<span class="var-name">$url</span>, [<span class="var-type">$contentType</span>&nbsp;<span class="var-name">$contentType</span> = <span class="var-default">&quot;application/x-www-form-urlencoded&quot;</span>], [<span class="var-type">$content</span>&nbsp;<span class="var-name">$content</span> = <span class="var-default">array()</span>], [<span class="var-type">$timeout</span>&nbsp;<span class="var-name">$timeout</span> = <span class="var-default">NULL</span>])
			</div>
	
			<ul class="parameters">
					<li>
				<span class="var-type">$url</span>
				<span class="var-name">$url</span><span class="var-description">: The URL to request.</span>			</li>
					<li>
				<span class="var-type">$contentType</span>
				<span class="var-name">$contentType</span><span class="var-description">: The Content-Type of the POST data.</span>			</li>
					<li>
				<span class="var-type">$content</span>
				<span class="var-name">$content</span><span class="var-description">: The content to be POST.</span>			</li>
					<li>
				<span class="var-type">$timeout</span>
				<span class="var-name">$timeout</span><span class="var-description">: Optional, the number of seconds to wait for the request to return.</span>			</li>
				</ul>
		
			
	</div>
<a name="methodput" id="put"><!-- --></a>
<div class="evenrow">
	
	<div class="method-header">
		<img src="../media/images/Method.png" />
		<span class="method-title">put</span> (line <span class="line-number"><a href="../__filesource/fsource_yos-social-php__Yahoo.inc.html#a1739">1739</a></span>)
	</div> 
	
	<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Executes a properly signed OAuth HTTP PUT request.</p>
<p class="description"><p>Executes a properly signed OAuth HTTP PUT request.</p></p>
	<ul class="tags">
				<li><span class="field">return:</span> response object.</li>
			</ul>
	
	<div class="method-signature">
		<span class="method-result">The</span>
		<span class="method-name">
			put
		</span>
					(<span class="var-type">$url</span>&nbsp;<span class="var-name">$url</span>, <span class="var-type">$contentType</span>&nbsp;<span class="var-name">$contentType</span>, <span class="var-type">$content</span>&nbsp;<span class="var-name">$content</span>, [<span class="var-type">$timeout</span>&nbsp;<span class="var-name">$timeout</span> = <span class="var-default">NULL</span>])
			</div>
	
			<ul class="parameters">
					<li>
				<span class="var-type">$url</span>
				<span class="var-name">$url</span><span class="var-description">: The URL to request.</span>			</li>
					<li>
				<span class="var-type">$contentType</span>
				<span class="var-name">$contentType</span><span class="var-description">: The Content-Type of the PUT data.</span>			</li>
					<li>
				<span class="var-type">$content</span>
				<span class="var-name">$content</span><span class="var-description">: The raw content to be PUT.</span>			</li>
					<li>
				<span class="var-type">$timeout</span>
				<span class="var-name">$timeout</span><span class="var-description">: Optional, the number of seconds to wait for the request to return.</span>			</li>
				</ul>
		
			
	</div>
<a name="methodrequest" id="request"><!-- --></a>
<div class="oddrow">
	
	<div class="method-header">
		<img src="../media/images/Method.png" />
		<span class="method-title">request</span> (line <span class="line-number"><a href="../__filesource/fsource_yos-social-php__Yahoo.inc.html#a1770">1770</a></span>)
	</div> 
	
	<!-- ========== Info from phpDoc block ========= -->
	<ul class="tags">
				<li><span class="field">private:</span> </li>
			</ul>
	
	<div class="method-signature">
		<span class="method-result">void</span>
		<span class="method-name">
			request
		</span>
					(<span class="var-type"></span>&nbsp;<span class="var-name">$request</span>)
			</div>
	
			<ul class="parameters">
					<li>
				<span class="var-type"></span>
				<span class="var-name">$request</span>			</li>
				</ul>
		
			
	</div>
						
		</div>
	</div>

	
	<p class="notes" id="credit">
		Documentation generated on Thu, 22 Oct 2009 12:54:52 -0700 by <a href="http://www.phpdoc.org" target="_blank">phpDocumentor 1.4.3</a>
	</p>
	</div></body>
</html>